/*
 * Copyright 2000-2012 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.spellchecker.dictionary;

import com.intellij.util.Consumer;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Set;

public interface Dictionary {
  default void consumeSuggestions(@NotNull String word, @NotNull Consumer<String> consumer) {}

  @NotNull
  String getName();

  @Nullable
  Boolean contains(@NotNull String word);

  @NotNull
  Set<String> getWords();

  /** @deprecated not used */
  @Deprecated
  @ApiStatus.ScheduledForRemoval(inVersion = "2020.2")
  default boolean isEmpty() {
    return true;
  }

  /** @deprecated not used */
  @Deprecated
  @ApiStatus.ScheduledForRemoval(inVersion = "2020.2")
  default void traverse(@SuppressWarnings("unused") @NotNull Consumer<String> action) {}

  /** @deprecated not used */
  @Deprecated
  @ApiStatus.ScheduledForRemoval(inVersion = "2020.2")
  default int size() {
    return 0;
  }
}
